IApi.WriteAxisProfileDeceleration method

Sets the Profile Deceleration of an axis.

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

KsError WriteAxisProfileDeceleration(
       int Index,
       int Value
)

Function WriteAxisProfileDeceleration(
       Index As Integer,
       Value As Integer
) As KsError

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Value

Type: int

The value to write.

Return value

Type: KsError

A return code of a method.

Remarks

• Used in the cyclic callback to update the Profile Deceleration of an axis.

• This function can be used only in Manual mode. See the McControlMode enum.

NOTE:  The Profile Deceleration is available only if EnableProfilePosition is enabled.

Usable EtherCAT states

ecatOP

Examples

N/A

See also

IApi Interface

IntervalZero.KINGSTAR.Base.Api Namespace